Run a Document report

To run reports based on 'Document Report' report templates, follow these steps.

Open the Document Report Settings tab

Go to the Reporting workspace and the Document Report Settings tab should open automatically. If not, click the New button in the Home tab on the ribbon.

You can access this screen from the Manage Data workspace: select a hierarchy node and click the Run Reports button in the Tools tab on the ribbon (or right-click a hierarchy node and select the Run Reports option from the context menu).

Select the hierarchy version and the nodes for reporting

Select the version of the hierarchy to be used from the drop-down list above the hierarchy.

You can report on multiple nodes of the hierarchy, with all or some of the child nodes included. You can manually select nodes to include by browsing the hierarchy and checking the boxes next to the node names.

Or, click a hierarchy node and use the Select button and the De-select button on the ribbon. If you click the icon part of the button, you select/deselect just that node. If you click the arrow under the button, you can choose one of these options:

• Select/Deselect Node selects/deselects the selected node.
• Select/Deselect Node and Children selects/deselects the selected node and all the nodes underneath it.
• Select/Deselect Children selects/deselects all nodes under the selected node but not that node itself.

Select the report templates

To add report templates which will be used to generate reports, click the Select Reports button on the ribbon (or in the empty Selected Reports panel in the middle of the screen). The list of available templates will be displayed in a pop-up window. Select templates by checking the boxes next to their names, and click OK to close the dialog.

To remove a template, click its remove button at the right-hand side. Or, use the Remove All button on the ribbon to remove all of the selected templates.

The currently-selected report templates will be displayed in the Reports panel. Use each report's Expand/Collapse button to see the report details, or use the Expand and Collapse buttons on the ribbon to show/hide for all of the reports.

Important: Some templates can include parameters that you need to check or set. See the example screenshot below.

Report Settings

Fill-in the settings for report generation in the Report Settings panel. See Report Settings.

Note: Report names are set automatically and cannot be edited; they are formed from the template name and a datetime string ('YYYYMMDDHHMMSS') that is set when the Run Report job is submitted.

Run the report generation

Click the Run Reports button on the ribbon to start the generation of the report(s). The button will be grayed out if any of the setup steps above are not completed.

Report generation jobs are run on the IPS Server, thus you can submit multiple report jobs to run automatically, and track their progress later. Each job will be processsed as a number of tasks, which can be monitored using the task notification area at the bottom of the screen (see task notification area). There will be a separate progress item for each report that is being generated. When a report is completed, you will see an orange pop-up bubble as shown below:

To view task progress, click in the progress bar in the task notification area which will show a list of completed, running and queued tasks. Completed report generation tasks will be displayed with a blue (successful) or red (error) progress bar. Click the down-arrow button next to a job item to open the menu:

• Open opens the report in Planning Space (if it is PRNX format), or using the appropriate default application in your computer, if an application is available (see Output types).
• Browse Folder opens a File Explorer in the folder where the report has been saved.
• Show Log shows log information about the report generation (this log can't be viewed while the job is running).

If you close your current Planning Space session while some reporting jobs are still running, these become 'background' server jobs that will run and finish independent of your client. When you login the next time you can use the Retrieve Reports button to check the IPS Server for any background reporting jobs that were left running when the previous session ended, and you can retrieve completed reports and log information from those jobs (see Background reporting jobs).